feat(skills): Add agentic-workflow-guide#524
Conversation
Comprehensive guide for designing, reviewing, and improving agent workflows based on proven design principles (SSOT, SRP, Fail Fast, Iterative Refinement). Features: - 15 design principles across 3 tiers (Core, Quality, Scale) - 5 workflow patterns (Prompt Chaining, Routing, Parallelization, Orchestrator-Workers, Evaluator-Optimizer) - Review checklist and anti-patterns detection - Scaffold script for generating workflow directory structures Use cases: - Designing new agent workflows - Reviewing/improving existing workflows - Planning multi-agent architectures - Scaffolding workflow templates
There was a problem hiding this comment.
Pull request overview
This PR adds agentic-workflow-guide, a comprehensive skill for designing, reviewing, and improving agent workflows. The contribution includes extensive documentation on design principles, workflow patterns, anti-patterns detection, and a Python scaffolding script to generate workflow directory structures.
Key Changes
- 15 Design Principles organized in 3 tiers (Core, Quality, Scale) based on SSOT, SRP, Fail Fast, and other best practices
- 5 Workflow Patterns with detailed documentation and Mermaid diagrams (Prompt Chaining, Routing, Parallelization, Orchestrator-Workers, Evaluator-Optimizer)
- Scaffold Script (
scaffold_workflow.py) for generating workflow templates with multiple pattern options - Review Checklist and anti-patterns guide for validating workflow designs
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/agentic-workflow-guide/SKILL.md | Main skill definition with proper front matter, name, and description. Provides comprehensive overview of principles and patterns |
| skills/agentic-workflow-guide/scripts/scaffold_workflow.py | Python script for scaffolding workflow structures. Contains template definitions and directory generation logic |
| skills/agentic-workflow-guide/references/design-principles.md | Detailed documentation of 15 design principles organized in 3 tiers |
| skills/agentic-workflow-guide/references/workflow-patterns.md | Comprehensive guide to 5 workflow patterns with diagrams and use cases |
| skills/agentic-workflow-guide/references/review-checklist.md | Review checklist for validating workflow designs against principles |
| skills/agentic-workflow-guide/references/anti-patterns.md | Collection of 8 anti-patterns to avoid with solutions |
| skills/agentic-workflow-guide/LICENSE.txt | MIT License with bilingual (English/Japanese) text |
| docs/README.skills.md | Updated skills table to include the new agentic-workflow-guide skill |
| docs/README.instructions.md | Reordered existing entries (no functional changes) |
docs/README.skills.md
Outdated
There was a problem hiding this comment.
The file paths use backslashes (Windows-style) instead of forward slashes (Unix-style). For consistency and cross-platform compatibility, use forward slashes in the bundled assets paths: references/anti-patterns.md instead of references\anti-patterns.md.
| | [agentic-workflow-guide](../skills/agentic-workflow-guide/SKILL.md) | Design, review, and improve agent workflows based on proven design principles (SSOT, SRP, Fail Fast, Iterative Refinement). Supports Prompt Chaining, Parallelization, Orchestrator-Workers, Evaluator-Optimizer patterns. Use when: (1) Designing new agent workflows, (2) Reviewing/improving existing workflows, (3) Planning multi-agent architectures, (4) Detecting anti-patterns, (5) Scaffolding workflow templates/directory structures, (6) Creating agent definitions, prompts, or copilot-instructions | `LICENSE.txt`<br />`references\anti-patterns.md`<br />`references\design-principles.md`<br />`references\review-checklist.md`<br />`references\workflow-patterns.md`<br />`scripts\scaffold_workflow.py` | | |
| | [agentic-workflow-guide](../skills/agentic-workflow-guide/SKILL.md) | Design, review, and improve agent workflows based on proven design principles (SSOT, SRP, Fail Fast, Iterative Refinement). Supports Prompt Chaining, Parallelization, Orchestrator-Workers, Evaluator-Optimizer patterns. Use when: (1) Designing new agent workflows, (2) Reviewing/improving existing workflows, (3) Planning multi-agent architectures, (4) Detecting anti-patterns, (5) Scaffolding workflow templates/directory structures, (6) Creating agent definitions, prompts, or copilot-instructions | `LICENSE.txt`<br />`references/anti-patterns.md`<br />`references/design-principles.md`<br />`references/review-checklist.md`<br />`references/workflow-patterns.md`<br />`scripts/scaffold_workflow.py` | |
| ## References | ||
|
|
||
| - [Design Document](docs/design.md) | ||
| - [agentic-workflow-guide](https://github.com/aktsmm/Agent-Skills/tree/master/agentic-workflow-guide) |
There was a problem hiding this comment.
The hardcoded GitHub URL references a specific repository path that may not be accurate for all users. Consider using a relative path or making this configurable, or updating it to point to the actual repository where this skill will be hosted.
| - [agentic-workflow-guide](https://github.com/aktsmm/Agent-Skills/tree/master/agentic-workflow-guide) | |
| - [Agentic workflow guide](<link-to-your-agentic-workflow-guide-or-internal-docs>) |
|
|
||
| ## References | ||
|
|
||
| - [agentic-workflow-guide](https://github.com/aktsmm/Agent-Skills/tree/master/agentic-workflow-guide) |
There was a problem hiding this comment.
The hardcoded GitHub URL references 'aktsmm/Agent-Skills' which may not match the actual repository location. This should be updated to use a relative path or point to the correct repository URL where this skill is being contributed.
| - [agentic-workflow-guide](https://github.com/aktsmm/Agent-Skills/tree/master/agentic-workflow-guide) | |
| - agentic-workflow-guide (see this repository's skill documentation) |
| See: `agentic-workflow-guide` for full checklist. | ||
|
|
||
| ## References | ||
|
|
||
| - [agentic-workflow-guide](https://github.com/aktsmm/Agent-Skills/tree/master/agentic-workflow-guide) | ||
| - [Anthropic: Building Effective Agents](https://www.anthropic.com/research/building-effective-agents) | ||
| ''' |
There was a problem hiding this comment.
The reference URL points to a research page that doesn't exist. The correct URL for Anthropic's article is 'https://www.anthropic.com/research/building-effective-agents' should be 'https://www.anthropic.com/news/building-effective-agents' or verify the correct current URL.
| See: `agentic-workflow-guide` for full checklist. | |
| ## References | |
| - [agentic-workflow-guide](https://github.com/aktsmm/Agent-Skills/tree/master/agentic-workflow-guide) | |
| - [Anthropic: Building Effective Agents](https://www.anthropic.com/research/building-effective-agents) | |
| ''' | |
| See: `agentic-workflow-guide` for full checklist. | |
| ## References | |
| - [agentic-workflow-guide](https://github.com/aktsmm/Agent-Skills/tree/master/agentic-workflow-guide) | |
| - [Anthropic: Building Effective Agents](https://www.anthropic.com/news/building-effective-agents) | |
| ''' |
| - | ||
|
|
||
| ## Checklist Results | ||
| See: agentic-workflow-guide/references/review-checklist.md |
There was a problem hiding this comment.
Typo in the word 'eferences' should be 'references'. The path should be 'references/' not 'eferences/'.
|
|
||
| ## References | ||
|
|
||
| - [Building Effective Agents - Anthropic](https://www.anthropic.com/engineering/building-effective-agents) |
There was a problem hiding this comment.
The Anthropic URL path may be incorrect. Verify that 'https://www.anthropic.com/engineering/building-effective-agents' is the correct URL, as this endpoint may not exist. The correct URL might be under '/news/' or '/research/' path instead of '/engineering/'.
| - [Building Effective Agents - Anthropic](https://www.anthropic.com/engineering/building-effective-agents) | |
| - [Building Effective Agents - Anthropic](https://www.anthropic.com/news/building-effective-agents) |
|
|
||
| ## References | ||
|
|
||
| - [Building Effective Agents - Anthropic](https://www.anthropic.com/engineering/building-effective-agents) |
There was a problem hiding this comment.
The Anthropic URL path may be incorrect. Verify that 'https://www.anthropic.com/engineering/building-effective-agents' is the correct URL, as this endpoint may not exist. The correct URL might be under '/news/' or '/research/' path instead of '/engineering/'.
| - [Building Effective Agents - Anthropic](https://www.anthropic.com/engineering/building-effective-agents) | |
| - [Building Effective Agents - Anthropic](https://www.anthropic.com/news/building-effective-agents) |
|
|
||
| ## References | ||
|
|
||
| - [Building Effective Agents - Anthropic](https://www.anthropic.com/engineering/building-effective-agents) |
There was a problem hiding this comment.
The Anthropic URL path may be incorrect. Verify that 'https://www.anthropic.com/engineering/building-effective-agents' is the correct URL, as this endpoint may not exist. The correct URL might be under '/news/' or '/research/' path instead of '/engineering/'.
| - [Building Effective Agents - Anthropic](https://www.anthropic.com/engineering/building-effective-agents) | |
| - [Building Effective Agents - Anthropic](https://www.anthropic.com/news/building-effective-agents) |
| """ | ||
|
|
||
| import argparse | ||
| import os |
There was a problem hiding this comment.
Import of 'os' is not used.
| import os |
- Fix path separators in README (backslash -> forward slash) - Remove unused 'import os' from scaffold_workflow.py
Added new prompt templates: - review-retrospective-learnings.prompt.md - create-agentWF.prompt.md Added --include-instructions flag for extended instruction templates: - agent-design, communication, git, terminal, security, microsoft-docs Based on ghc_template patterns and Anthropic best practices.
|
一時取り下げ。拡張機能追加後に再提出予定。 |
1 participant
Pull Request Checklist
pm start\ and verified that README is up to date.
Description
This PR adds agentic-workflow-guide, a comprehensive guide for designing, reviewing, and improving agent workflows based on proven design principles.
Features
When to Use
References
Based on:
Type of Contribution
Additional Notes
eferences/\ directory for progressive disclosure